| SpringBoot整合阿里云OSS文件上传、下载、查看、删除 | 您所在的位置：网站首页 › oss › SpringBoot整合阿里云OSS文件上传、下载、查看、删除 |
SpringBoot整合阿里云OSS文件上传、下载、查看、删除
|
该项目源码地址：https://github.com/ggb2312/JavaNotes/tree/master/springboot-integration-examples （其中包含SpringBoot和其他常用技术的整合，配套源码以及笔记。基于最新的 SpringBoot2.1+，欢迎各位 Star） 1. 开发前准备 1.1 前置知识 java基础 SpringBoot简单基础知识 1.2 环境参数 开发工具：IDEA 基础环境：Maven+JDK8 所用技术：SpringBoot、lombok、阿里云OSS存储服务 SpringBoot版本：2.1.4 1.3 涉及知识点 OSS简介，以及阿里云OSS控制台快速入门使用 SpringBoot 整合 阿里云OSS 存储服务，进行文件上传、下载、查看、删除 阿里云OSS文档介绍，以及快速入门使用 lombok入门使用以及IDEA lombok插件安装 SpringMVC与AJAX前后端分离交互 AJAX文件异步上传 2. 使用阿里云OSS对象存储OSS的多重冗余架构设计，为数据持久存储提供可靠保障。 2.1 创建Bucket使用OSS，首先需要创建Bucket，Bucket翻译成中文是水桶的意思，把存储的图片资源看做是水，想要盛水必须得 有桶。 进入控制台，https://oss.console.aliyun.com/overview 
新建Bucket
新建 Bucket
创建完成后，在左侧可以看到已经创建好的Bucket： 
Bucket
选择Bucket后，即可看到对应的信息，如：url、消耗流量等 
Bucket相关信息
2.2 管理文件
可以通过在线的方式进行管理文件 
管理文件
2.3 阿里云OSS文档
阿里云OSS文档 
阿里云OSS文档
右侧的开发指南说的更加详细 
开发指南
阿里云虽然提供了完整的文档，但是做一个完整的前后端交互的文件上传、下载、查看、删除等操作，对于小白来说还是有点难度的，所以我把自己学习OSS的步骤以及代码分享了出来，共有需要的人使用。 3. 项目初始化 3.1 创建SpringBoot项目在Idea中File——>New——>Project 
创建SpringBoot项目 步骤一
创建SpringBoot项目 步骤二
创建SpringBoot项目 步骤三
创建SpringBoot项目 步骤四
3.2 Maven依赖
导入Maven相关依赖 com.aliyun.oss aliyun-sdk-oss 2.8.3 org.projectlombok lombok 1.18.4 provided joda-time joda-time 2.9.9 org.apache.commons commons-lang3 3.8.1 3.3 安装lombok插件因为项目中使用了lombok的@Data注解，当然你也可以自己写get、set等方法。 File——>settings——>Plugins 
安装lombok插件
安装lombok插件
然后restart IDEA即可。 4. 后端服务编写
项目结构
4.1 阿里云OSS配置
在resource下新建一个application-oss.properties aliyun.endpoint=oss-cn-shanghai.aliyuncs.com aliyun.accessKeyId=你的accessKeyId aliyun.accessKeySecret=你的accessKeySecret aliyun.bucketName=gaojun-testbucket aliyun.urlPrefix=http://gaojun-testbucket.oss-cn-shanghai.aliyuncs.com/ spring.servlet.multipart.max-file-size=100MB spring.servlet.multipart.max-request-size=1000MBendpoint、bucketName、urlPrefix在OSS主面板就可以看到 
bucketName、endpoint与urlPrefix
accessKeyId、accessKeySecret需要在accesskeys里面查看 
accesskeys与accessKeySecret
在java的包下新建一个config包，创建一个AliyunConfig.java package com.example.ossdemo.config; import com.aliyun.oss.OSS; import com.aliyun.oss.OSSClient; import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.PropertySource; /** * @desc * * @author lastwhisper * @email [email protected] */ @Configuration @PropertySource(value = {"classpath:application-oss.properties"}) @ConfigurationProperties(prefix = "aliyun") @Data public class AliyunConfig { private String endpoint; private String accessKeyId; private String accessKeySecret; private String bucketName; private String urlPrefix; @Bean public OSS oSSClient() { return new OSSClient(endpoint, accessKeyId, accessKeySecret); } } 4.2 后端业务 4.2.1 vo该实体类用于后台返回给前台。 package com.example.ossdemo.vo; import lombok.Data; /** * @author lastwhisper * @desc 用于前后端交互的返回值 * @email [email protected] */ @Data public class FileUploadResult { // 文件唯一标识 private String uid; // 文件名 private String name; // 状态有：uploading done error removed private String status; // 服务端响应内容，如：'{"status": "success"}' private String response; } 4.2.2 service在service使用ossClient操作阿里云OSS，进行上传、下载、删除、查看所有文件等操作，同时可以将图片的url进行入库操作。 package com.example.ossdemo.service; import com.aliyun.oss.OSS; import com.aliyun.oss.model.*; import com.example.ossdemo.config.AliyunConfig; import com.example.ossdemo.vo.FileUploadResult; import org.apache.commons.lang3.RandomUtils; import org.apache.commons.lang3.StringUtils; import org.joda.time.DateTime; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import org.springframework.web.multipart.MultipartFile; import java.io.*; import java.util.List; /** * @author lastwhisper * @desc * @email [email protected] */ @Service public class FileUploadService { // 允许上传的格式 private static final String[] IMAGE_TYPE = new String[]{".bmp", ".jpg", ".jpeg", ".gif", ".png"}; @Autowired private OSS ossClient; @Autowired private AliyunConfig aliyunConfig; /** * @author lastwhisper * @desc 文件上传 * 文档链接 https://help.aliyun.com/document_detail/84781.html?spm=a2c4g.11186623.6.749.11987a7dRYVSzn * @email [email protected] */ public FileUploadResult upload(MultipartFile uploadFile) { // 校验图片格式 boolean isLegal = false; for (String type : IMAGE_TYPE) { if (StringUtils.endsWithIgnoreCase(uploadFile.getOriginalFilename(), type)) { isLegal = true; break; } } //封装Result对象，并且将文件的byte数组放置到result对象中 FileUploadResult fileUploadResult = new FileUploadResult(); if (!isLegal) { fileUploadResult.setStatus("error"); return fileUploadResult; } //文件新路径 String fileName = uploadFile.getOriginalFilename(); String filePath = getFilePath(fileName); // 上传到阿里云 try { ossClient.putObject(aliyunConfig.getBucketName(), filePath, new ByteArrayInputStream(uploadFile.getBytes())); } catch (Exception e) { e.printStackTrace(); //上传失败 fileUploadResult.setStatus("error"); return fileUploadResult; } fileUploadResult.setStatus("done"); fileUploadResult.setResponse("success"); //this.aliyunConfig.getUrlPrefix() + filePath 文件路径需要保存到数据库 fileUploadResult.setName(this.aliyunConfig.getUrlPrefix() + filePath); fileUploadResult.setUid(String.valueOf(System.currentTimeMillis())); return fileUploadResult; } /** * @author lastwhisper * @desc 生成路径以及文件名 例如：//images/2019/04/28/15564277465972939.jpg * @email [email protected] */ private String getFilePath(String sourceFileName) { DateTime dateTime = new DateTime(); return "images/" + dateTime.toString("yyyy") + "/" + dateTime.toString("MM") + "/" + dateTime.toString("dd") + "/" + System.currentTimeMillis() + RandomUtils.nextInt(100, 9999) + "." + StringUtils.substringAfterLast(sourceFileName, "."); } /** * @author lastwhisper * @desc 查看文件列表 * 文档链接 https://help.aliyun.com/document_detail/84841.html?spm=a2c4g.11186623.2.13.3ad5b5ddqxWWRu#concept-84841-zh * @email [email protected] */ public List list() { // 设置最大个数。 final int maxKeys = 200; // 列举文件。 ObjectListing objectListing = ossClient.listObjects(new ListObjectsRequest(aliyunConfig.getBucketName()).withMaxKeys(maxKeys)); List sums = objectListing.getObjectSummaries(); return sums; } /** * @author lastwhisper * @desc 删除文件 * 文档链接 https://help.aliyun.com/document_detail/84842.html?spm=a2c4g.11186623.6.770.4f9474b4UYlCtr * @email [email protected] */ public FileUploadResult delete(String objectName) { // 根据BucketName,objectName删除文件 ossClient.deleteObject(aliyunConfig.getBucketName(), objectName); FileUploadResult fileUploadResult = new FileUploadResult(); fileUploadResult.setName(objectName); fileUploadResult.setStatus("removed"); fileUploadResult.setResponse("success"); return fileUploadResult; } /** * @author lastwhisper * @desc 下载文件 * 文档链接 https://help.aliyun.com/document_detail/84823.html?spm=a2c4g.11186623.2.7.37836e84ZIuZaC#concept-84823-zh * @email [email protected] */ public void exportOssFile(OutputStream os, String objectName) throws IOException { // ossObject包含文件所在的存储空间名称、文件名称、文件元信息以及一个输入流。 OSSObject ossObject = ossClient.getObject(aliyunConfig.getBucketName(), objectName); // 读取文件内容。 BufferedInputStream in = new BufferedInputStream(ossObject.getObjectContent()); BufferedOutputStream out = new BufferedOutputStream(os); byte[] buffer = new byte[1024]; int lenght = 0; while ((lenght = in.read(buffer)) != -1) { out.write(buffer, 0, lenght); } if (out != null) { out.flush(); out.close(); } if (in != null) { in.close(); } } } 4.2.3 controllercontroller进行接收用户请求 package com.example.ossdemo.controller; import com.aliyun.oss.model.OSSObjectSummary; import com.example.ossdemo.service.FileUploadService; import com.example.ossdemo.vo.FileUploadResult; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.multipart.MultipartFile; import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.io.InputStream; import java.net.URLEncoder; import java.util.List; /** * @author lastwhisper * @desc * @email [email protected] */ @Controller public class FileUploadController { @Autowired private FileUploadService fileUploadService; /** * @author lastwhisper * @desc 文件上传到oss * @return FileUploadResult * @Param uploadFile */ @RequestMapping("file/upload") @ResponseBody public FileUploadResult upload(@RequestParam("file") MultipartFile uploadFile) throws Exception { return this.fileUploadService.upload(uploadFile); } /** * @return FileUploadResult * @desc 根据文件名删除oss上的文件 * http://localhost:8080/file/delete?fileName=images/2019/04/28/1556429167175766.jpg * @author lastwhisper * @Param objectName */ @RequestMapping("file/delete") @ResponseBody public FileUploadResult delete(@RequestParam("fileName") String objectName) throws Exception { return this.fileUploadService.delete(objectName); } /** * @author lastwhisper * @desc 查询oss上的所有文件 * http://localhost:8080/file/list * @return List * @Param */ @RequestMapping("file/list") @ResponseBody public List list() throws Exception { return this.fileUploadService.list(); } /** * @author lastwhisper * @desc 根据文件名下载oss上的文件 * @return * @Param objectName */ @RequestMapping("file/download") @ResponseBody public void download(@RequestParam("fileName") String objectName, HttpServletResponse response) throws IOException { //通知浏览器以附件形式下载 response.setHeader("Content-Disposition", "attachment;filename=" + new String(objectName.getBytes(), "ISO-8859-1")); this.fileUploadService.exportOssFile(response.getOutputStream(),objectName); } } 5. 前端页面编写与测试 5.1 文件上传页面使用ajax异步文件上传到后端对接的OSS上。 oss文件上传 function uploadfile() { $("#fileTypeError").html(''); //获得文件名称 var fileName = $('#file_upload').val(); //截取文件类型,如(.jpg) var fileType = fileName.substr(fileName.length - 4, fileName.length); if (fileType == '.bmp' || fileType == '.jpg' || fileType == '.jpeg' || fileType == '.gif' || fileType == '.png') { //验证文件类型,此处验证也可使用正则 $.ajax({ url: 'file/upload',//上传地址 type: 'POST', cache: false, data: new FormData($('#uploadForm')[0]),//表单数据 processData: false, contentType: false, success: function (rtn) { if (rtn.status == 'error') { $("#fileTypeError").html('*上传文件类型错误,支持类型: .bmp .jpg .jpeg .gif .png'); //根据后端返回值,回显错误信息 } else { $('div').append('效果展示： 
ajax文件上传到OSS
ajax文件上传到OSS
ajax文件上传到OSS成功
5.2 文件管理页面
oss文件管理
var pre = 'https://gaojun-testbucket.oss-cn-shanghai.aliyuncs.com/';
$(function () {
listfile();
});
//文件列表
function listfile() {
$.ajax({
url: "http://localhost:8080/file/list",
type: 'POST',
success: function (rtn) {
console.log(rtn.length);
for (var i = 0; i < rtn.length; i++) {
$('div').append('效果展示： 刚才上传了一张照片，可以立马看到 
文件管理
单击页面即可下载图片 
image.png
双击即可删除图片： 
删除图片
删除图片
|
【本文地址】
公司简介
联系我们